Sphinx Autobuild

Posted on Sat 26 February 2022 in Linux-Open-Source

Sphinx Autobuild

Important

Sphinx-autobuild is a handy extension to have when producing documentation and want to check how it appears right away after making a change.

When it's run, it'll keep an eye on the source files and re-build our documentation if one of them changes. Furthermore, it will update our browser's page to reflect the new modifications.

Installation`

pip install sphinx-autobuild

Usage

Run this command in your terminal,

sphinx-autobuild docs docs/build/html

docs is the directory of your source documentation

docs/build/html is the directory where the output will be written

Then, access http://127.0.0.1:8000/ with your browser.

awesome thanks